package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.CrmOperationRecordAddDTO;
import org.jsola.hr.dto.CrmOperationRecordUpdateDTO;
import org.jsola.hr.query.CrmOperationRecordQuery;
import org.jsola.hr.vo.CrmOperationRecordListVO;
import org.jsola.hr.vo.CrmOperationRecordVO;

import java.util.List;

/**
 * 操作记录表
 *
 * @author zhr
 */
@Api(tags = "hr-操作记录表")
public interface ICrmOperationRecordControllerAPI {

    /**
     * 新增操作记录表
     * @param crmOperationRecordAddDTO 操作记录表新增实体
     * @return 操作记录表展示对象
     */
    @ApiOperation(value = "新增操作记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmOperationRecordAddDTO", dataType = "CrmOperationRecordAddDTO", value = "新增操作记录表", paramType = "body")
    })
    Result<CrmOperationRecordVO> save(CrmOperationRecordAddDTO crmOperationRecordAddDTO);


    /**
     * 修改操作记录表
     * @param crmOperationRecordUpdateDTO 操作记录表
     * @return 更新数量
     */
    @ApiOperation(value = "修改操作记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmOperationRecordUpdateDTO", dataType = "CrmOperationRecordUpdateDTO", value = "修改操作记录表", paramType = "body")
    })
    Result<Integer> update(CrmOperationRecordUpdateDTO crmOperationRecordUpdateDTO);




    /**
     * 删除单个操作记录表，彻底删除
     * @param crmOperationRecordId 操作记录表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个操作记录表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmOperationRecordId", dataType = "String", value = "操作记录表id", paramType = "path")
    })
    Result<Integer> delete(String crmOperationRecordId);


    /**
     * 批量删除操作记录表，彻底删除
     * @param crmOperationRecordIds 操作记录表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除操作记录表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmOperationRecordIds", dataType = "String[]", value = "操作记录表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] crmOperationRecordIds);


    /**
     * 根据操作记录表id查询操作记录表详情
     * @param crmOperationRecordId 操作记录表id
     * @return 操作记录表详情
     */
    @ApiOperation(value="根据操作记录表id查询操作记录表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmOperationRecordId", dataType = "String", value = "操作记录表id", paramType = "path")
    })
    Result<CrmOperationRecordVO> findById(String crmOperationRecordId);


    /**
     * 查询操作记录表
     * @param crmOperationRecordQuery 操作记录表查询参数
     * @return page
     */
    @ApiOperation(value="查询操作记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmOperationRecordQuery", dataType = "CrmOperationRecordQuery", value = "操作记录表查询参数", paramType = "query")
    })
    Result<List<CrmOperationRecordListVO>> listAll(CrmOperationRecordQuery crmOperationRecordQuery);


     /**
     * 分页查询操作记录表
     * @param crmOperationRecordQuery 操作记录表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询操作记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmOperationRecordQuery", dataType = "CrmOperationRecordQuery", value = "操作记录表查询参数", paramType = "query")
    })
    Result<Page<CrmOperationRecordListVO>> page(CrmOperationRecordQuery crmOperationRecordQuery);


}

